Skip to content

Added url redirects #632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 12, 2025
Merged

Added url redirects #632

merged 2 commits into from
Aug 12, 2025

Conversation

shravanngoswamii
Copy link
Member

We have to keep atleast two redirect files in this directory -- Quarto lisiting behavior, we have to deal with it!

Ref: TuringLang/Turing.jl#2637 (comment)

Copy link
Contributor

github-actions bot commented Aug 7, 2025

Preview the changes: https://turinglang.org/docs/pr-previews/632
Please avoid using the search feature and navigation bar in PR previews!

@shravanngoswamii
Copy link
Member Author

@penelopeysm
Copy link
Member

I see the intent here, although I can't help but get the feeling that it might be a bit overkill. Also specifying the redirect in a different page from the troubleshooting page means that if you do actually move the troubleshooting qmd file, you have to remember to edit the redirect page, which feels quite unlikely.

Would it be sufficient to add an aliases in the troubleshooting page itself? And maybe add a comment in the page itself to say that 'this URL is used in Turing.jl here, if you move this file please make sure to retain it'?

@shravanngoswamii
Copy link
Member Author

shravanngoswamii commented Aug 7, 2025

Would it be sufficient to add an aliases in the troubleshooting page itself?

In the long run, we may need more redirects, so having them in one place helps with scalability and maintenance. Adding aliases in the individual page works too, but isn’t ideal if there are many redirects. Also, if a page gets moved, it's likely by one of us who knows the workflow. I suggest we just add a note in the README to make that clear.

@penelopeysm
Copy link
Member

Also, if a page gets moved, it's likely by one of us who knows the workflow.

Probably yes, but even though I've seen this PR, I guarantee I'll forget.

I think the best solution is a link checker in CI (not for this PR, maybe one day).

@shravanngoswamii
Copy link
Member Author

I think the best solution is a link checker in CI (not for this PR, maybe one day).

I remember we also have a issue for this, will try to fix it someday!

@yebai
Copy link
Member

yebai commented Aug 7, 2025

Would it be sufficient to add an aliases in the troubleshooting page itself? And maybe add a comment in the page itself to say that 'this URL is used in Turing.jl here, if you move this file please make sure to retain it'?

I like @penelopeysm's proposal here. The current approach seems overkill -- it's unlikely we will have lots of redirects.

@shravanngoswamii
Copy link
Member Author

I agree to both of you but using aliases in file itself will redirect to https://turinglang.org/docs/usage/troubleshooting/ page and not some particular section link like https://turinglang.org/docs/usage/troubleshooting/#initial-parameters -- We can only achieve it using current approach.

Copy link
Contributor

@AoifeHughes AoifeHughes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable for redirects!

@shravanngoswamii
Copy link
Member Author

shravanngoswamii commented Aug 12, 2025

@AoifeHughes Please feel free to use this based on your requirements in this PR -- TuringLang/Turing.jl#2637 (comment)

@shravanngoswamii shravanngoswamii merged commit 883b97a into main Aug 12, 2025
1 of 2 checks passed
@shravanngoswamii shravanngoswamii deleted the sg/redirects branch August 12, 2025 17:57
github-actions bot added a commit that referenced this pull request Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants